/
IPriorityQueue`2.xml
303 lines (285 loc) · 15.2 KB
/
IPriorityQueue`2.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
<Type Name="IPriorityQueue<TValue,TCont>" FullName="Microsoft.VisualC.StlClr.IPriorityQueue<TValue,TCont>">
<TypeSignature Language="C#" Value="public interface IPriorityQueue<TValue,TCont> : ICloneable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IPriorityQueue`2<TValue, TCont> implements class System.ICloneable" />
<TypeSignature Language="DocId" Value="T:Microsoft.VisualC.StlClr.IPriorityQueue`2" />
<TypeSignature Language="VB.NET" Value="Public Interface IPriorityQueue(Of TValue, TCont)
Implements ICloneable" />
<TypeSignature Language="F#" Value="type IPriorityQueue<'Value, 'Cont> = interface
 interface ICloneable" />
<TypeSignature Language="C++ CLI" Value="generic <typename TValue, typename TCont>
public interface class IPriorityQueue : ICloneable" />
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TValue" />
<TypeParameter Name="TCont" />
</TypeParameters>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TValue">The type of an element in the controlled sequence.</typeparam>
<typeparam name="TCont">The type of the underlying container.</typeparam>
<summary>Defines the interface for an STL/CLR <see href="https://docs.microsoft.com/cpp/dotnet/priority-queue-stl-clr">priority_queue</see> object.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="assign">
<MemberSignature Language="C#" Value="public void assign (Microsoft.VisualC.StlClr.IPriorityQueue<TValue,TCont> _Right);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void assign(class Microsoft.VisualC.StlClr.IPriorityQueue`2<!TValue, !TCont> _Right) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.assign(Microsoft.VisualC.StlClr.IPriorityQueue{`0,`1})" />
<MemberSignature Language="VB.NET" Value="Public Sub assign (_Right As IPriorityQueue(Of TValue, TCont))" />
<MemberSignature Language="F#" Value="abstract member assign : Microsoft.VisualC.StlClr.IPriorityQueue<'Value, 'Cont> -> unit" Usage="iPriorityQueue.assign _Right" />
<MemberSignature Language="C++ CLI" Value="public:
 void assign(Microsoft::VisualC::StlClr::IPriorityQueue<TValue, TCont> ^ _Right);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="_Right" Type="Microsoft.VisualC.StlClr.IPriorityQueue<TValue,TCont>" />
</Parameters>
<Docs>
<param name="_Right">The container adapter to insert into the container.</param>
<summary>Replaces all elements of the container.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="empty">
<MemberSignature Language="C#" Value="public bool empty ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool empty() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.empty" />
<MemberSignature Language="VB.NET" Value="Public Function empty () As Boolean" />
<MemberSignature Language="F#" Value="abstract member empty : unit -> bool" Usage="iPriorityQueue.empty " />
<MemberSignature Language="C++ CLI" Value="public:
 bool empty();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether the container contains no elements.</summary>
<returns>
<see langword="true" /> if the container contains no elements; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="get_container">
<MemberSignature Language="C#" Value="public TCont get_container ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TCont get_container() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.get_container" />
<MemberSignature Language="VB.NET" Value="Public Function get_container () As TCont" />
<MemberSignature Language="F#" Value="abstract member get_container : unit -> 'Cont" Usage="iPriorityQueue.get_container " />
<MemberSignature Language="C++ CLI" Value="public:
 TCont get_container();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TCont</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Accesses the underlying container.</summary>
<returns>The underlying container. You can use it to bypass the restrictions that are imposed by the container wrapper.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="pop">
<MemberSignature Language="C#" Value="public void pop ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void pop() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.pop" />
<MemberSignature Language="VB.NET" Value="Public Sub pop ()" />
<MemberSignature Language="F#" Value="abstract member pop : unit -> unit" Usage="iPriorityQueue.pop " />
<MemberSignature Language="C++ CLI" Value="public:
 void pop();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes the highest-priority element of the container.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="push">
<MemberSignature Language="C#" Value="public void push (TValue _Val);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void push(!TValue _Val) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.push(`0)" />
<MemberSignature Language="VB.NET" Value="Public Sub push (_Val As TValue)" />
<MemberSignature Language="F#" Value="abstract member push : 'Value -> unit" Usage="iPriorityQueue.push _Val" />
<MemberSignature Language="C++ CLI" Value="public:
 void push(TValue _Val);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="_Val" Type="TValue" />
</Parameters>
<Docs>
<param name="_Val">An element to insert into the controlled sequence. The controlled sequence is then reordered to maintain the heap discipline.</param>
<summary>Adds a new element to the container.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="size">
<MemberSignature Language="C#" Value="public int size ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 size() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.size" />
<MemberSignature Language="VB.NET" Value="Public Function size () As Integer" />
<MemberSignature Language="F#" Value="abstract member size : unit -> int" Usage="iPriorityQueue.size " />
<MemberSignature Language="C++ CLI" Value="public:
 int size();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Counts the number of elements in the container.</summary>
<returns>The length of the controlled sequence.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="top">
<MemberSignature Language="C#" Value="public ref TValue top ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TValue top() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.top" />
<MemberSignature Language="VB.NET" Value="Public Function top () As TValue" />
<MemberSignature Language="F#" Value="abstract member top : unit -> 'Value" Usage="iPriorityQueue.top " />
<MemberSignature Language="C++ CLI" Value="public:
 TValue % top();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue RefType="Ref">
<ReturnType>TValue</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Accesses the highest-priority element of the container.</summary>
<returns>The top (highest-priority) element of the controlled sequence, which must be non-empty.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="top_item">
<MemberSignature Language="C#" Value="public TValue top_item { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TValue top_item" />
<MemberSignature Language="DocId" Value="P:Microsoft.VisualC.StlClr.IPriorityQueue`2.top_item" />
<MemberSignature Language="VB.NET" Value="Public Property top_item As TValue" />
<MemberSignature Language="F#" Value="member this.top_item : 'Value with get, set" Usage="Microsoft.VisualC.StlClr.IPriorityQueue<'Value, 'Cont>.top_item" />
<MemberSignature Language="C++ CLI" Value="public:
 property TValue top_item { TValue get(); void set(TValue value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<Docs>
<summary>Accesses the highest-priority element of the container.</summary>
<value>The top (highest-priority) element of the controlled sequence, which must be non-empty.</value>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="value_comp">
<MemberSignature Language="C#" Value="public Microsoft.VisualC.StlClr.BinaryDelegate<TValue,TValue,bool> value_comp ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.VisualC.StlClr.BinaryDelegate`3<!TValue, !TValue, bool> value_comp() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.VisualC.StlClr.IPriorityQueue`2.value_comp" />
<MemberSignature Language="VB.NET" Value="Public Function value_comp () As BinaryDelegate(Of TValue, TValue, Boolean)" />
<MemberSignature Language="F#" Value="abstract member value_comp : unit -> Microsoft.VisualC.StlClr.BinaryDelegate<'Value, 'Value, bool>" Usage="iPriorityQueue.value_comp " />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::VisualC::StlClr::BinaryDelegate<TValue, TValue, bool> ^ value_comp();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.VisualC.STLCLR</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.VisualC.StlClr.BinaryDelegate<TValue,TValue,System.Boolean></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Copies the ordering delegate for two elements.</summary>
<returns>The ordering delegate used to order the controlled sequence. You use it to compare two values.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>